Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget/ValidationBackedNumberFieldWidget

ValidationBackedNumberFieldWidget

open class ValidationBackedNumberFieldWidget<T : Number>(width: Int, height: Int, wrappedValue: Supplier<T>, choiceValidator: ChoiceValidator<T>, validationProvider: Function<Double, ValidationResult<T>>, applier: Consumer<T> = Consumer { _ ->}) : TextFieldWidget

A TextFieldWidget for entering number values, backed by validation of some sort.

Author

fzzyhmstrs

Since

0.2.0

Parameters

T

extends Number

width

Int - width of the text field

height

Int - height of the text field

wrappedValue

Supplier - supplier of the value to display on the text field. This is separate from any values stored within the widget, and generally is the same source as the applier, so this widget is updated if any external changes are made to the number

choiceValidator

ChoiceValidator - additional choice validation, if any. Generally this can be ChoiceValidator.any

validationProvider

FunctionValidationResult> - validates the number entered. all numbers entered are treated as doubles internally until application.

applier

Consumer - accepts results from valid user entries

Constructors

ValidationBackedNumberFieldWidget

constructor(width: Int, height: Int, wrappedValue: Supplier<T>, choiceValidator: ChoiceValidator<T>, validationProvider: Function<Double, ValidationResult<T>>, applier: Consumer<T> = Consumer { _ ->})

Properties

var active: Boolean

var focused: Boolean

var message: Text

navigationOrder

var navigationOrder: Int

var text: String

@Nullable

@get:Nullable

var tooltip: Tooltip?

var visible: Boolean

var x: Int

var y: Int

Functions

appendClickableNarrations

open override fun appendClickableNarrations(builder: NarrationMessageBuilder)

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

open override fun charTyped(chr: Char, modifiers: Int): Boolean

drawsBackground

open fun drawsBackground(): Boolean

eraseCharacters

open fun eraseCharacters(characterOffset: Int)

eraseCharactersTo

open fun eraseCharactersTo(position: Int)

open fun eraseWords(wordOffset: Int)

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

open fun getBottom(): Int

open fun getCharacterX(index: Int): Int

open fun getCursor(): Int

@Nullable

open fun getFocusedPath(): GuiNavigationPath?

open override fun getHeight(): Int

open override fun getInnerWidth(): Int

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

@Nullable

open override fun getNavigationPath(navigation: GuiNavigation): GuiNavigationPath?

open fun getRight(): Int

getSelectedText

open fun getSelectedText(): String

open override fun getType(): Selectable.SelectionType

fun getValue(): T

returns the last valid value stored in this widget

open override fun getWidth(): Int

getWordSkipPosition

open fun getWordSkipPosition(wordOffset: Int): Int

open fun isActive(): Boolean

open fun isHovered(): Boolean

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

open override fun isNarratable(): Boolean

open fun isSelected(): Boolean

open fun isVisible(): Boolean

open override fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

open fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

open fun mouseMoved(mouseX: Double, mouseY: Double)

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

open fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

open fun moveCursor(offset: Int, shiftKeyPressed: Boolean)

open override fun onClick(mouseX: Double, mouseY: Double)

open fun onRelease(mouseX: Double, mouseY: Double)

open override fun playDownSound(soundManager: SoundManager)

fun prefixed(prefix: Text): ValidationBackedNumberFieldWidget<T>

Adds a prefix to narration of this number

override fun render(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

open override fun renderWidget(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

open fun setAlpha(alpha: Float)

setChangedListener

open fun setChangedListener(changedListener: Consumer<String>)

open fun setCursor(cursor: Int, shiftKeyPressed: Boolean)

open fun setCursorToEnd(shiftKeyPressed: Boolean)

setCursorToStart

open fun setCursorToStart(shiftKeyPressed: Boolean)

open fun setDimensions(width: Int, height: Int)

setDimensionsAndPosition

open fun setDimensionsAndPosition(width: Int, height: Int, x: Int, y: Int)

setDrawsBackground

open fun setDrawsBackground(drawsBackground: Boolean)

open fun setEditable(editable: Boolean)

setEditableColor

open fun setEditableColor(editableColor: Int)

setFocusUnlocked

open fun setFocusUnlocked(focusUnlocked: Boolean)

open fun setHeight(height: Int)

open fun setMaxLength(maxLength: Int)

open fun setPlaceholder(placeholder: Text)

open fun setPosition(x: Int, y: Int)

setRenderTextProvider

open fun setRenderTextProvider(renderTextProvider: BiFunction<String, Int, OrderedText>)

setSelectionEnd

open fun setSelectionEnd(index: Int)

setSelectionStart

open fun setSelectionStart(cursor: Int)

open fun setSuggestion(@Nullable suggestion: String?)

setTextPredicate

open fun setTextPredicate(textPredicate: Predicate<String>)

setTooltipDelay

open fun setTooltipDelay(delay: Int)

setUneditableColor

open fun setUneditableColor(uneditableColor: Int)

open fun setVisible(visible: Boolean)

open fun setWidth(width: Int)

open fun write(text: String)